This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/daf-spec
US Realm DAF Specimen Resource
This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Specimen.
This structure is derived from Specimen.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | US Realm DAF Specimen Resource | |
identifier | S | 0..* | Identifier | |
use | S | 1..1 | code | Fixed Value: official |
system | S | 1..1 | uri | Placer URI |
value | S | 1..1 | string | Placer Identifier |
type | S | 1..1 | CodeableConcept | Binding: USLab Specimen Type (extensible) |
coding | S | 1..* | Coding | |
system | S | 1..1 | uri | |
code | S | 1..1 | code | |
display | S | 0..1 | string | |
text | S | 0..1 | string | Display text |
subject | S | 1..1 | Reference(DAF-Patient) | Patient |
accessionIdentifier | S | 0..1 | Identifier | |
use | S | 1..1 | code | Fixed Value: official |
system | S | 1..1 | uri | Filler URI |
value | S | 1..1 | string | Filler Identifier |
collection | S | 0..1 | BackboneElement | |
collected[x] | S I | 1..1 | dateTime, Period | inv-2: Datetime must be at least to the day. |
bodySite | S | 0..1 | CodeableConcept | Binding: USLab Specimen Body Site (extensible) |
coding | S | 1..* | Coding | |
system | S | 1..1 | uri | |
code | S | 1..1 | code | |
display | S | 0..1 | string | |
text | S | 0..1 | string | Display text |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | US Realm DAF Specimen Resource | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 0..* | Identifier | External Identifier |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) Fixed Value: official |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | Placer URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | Placer Identifier Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?! ∑ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
type | S ∑ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: USLab Specimen Type (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |
subject | S ∑ | 1..1 | Reference(DAF-Patient) | Patient |
accessionIdentifier | S ∑ | 0..1 | Identifier | Identifier assigned by the lab |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) Fixed Value: official |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | Filler URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | Filler Identifier Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
receivedTime | ∑ | 0..1 | dateTime | The time when specimen was received for processing |
collection | S | 0..1 | BackboneElement | Collection details |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
collector | ∑ | 0..1 | Reference(Practitioner) | Who collected the specimen |
comment | 0..* | string | Collector comments | |
collected[x] | S ∑I | 1..1 | dateTime, Period | Collection time inv-2: Datetime must be at least to the day. |
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: SpecimenCollectionMethod (example) | |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: USLab Specimen Body Site (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
treatment | 0..* | BackboneElement | Treatment and processing step details | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Textual description of procedure | |
procedure | 0..1 | CodeableConcept | Indicates the treatment or processing step applied to the specimen Binding: SpecimenTreatmentProcedure (example) | |
additive | 0..* | Reference(Substance) | Material used in the processing step | |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Binding: v2 Additive/Preservative (example) | |
Documentation for this format |
todo
This structure is derived from Specimen.
Differential View
This structure is derived from Specimen.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | US Realm DAF Specimen Resource | |
identifier | S | 0..* | Identifier | |
use | S | 1..1 | code | Fixed Value: official |
system | S | 1..1 | uri | Placer URI |
value | S | 1..1 | string | Placer Identifier |
type | S | 1..1 | CodeableConcept | Binding: USLab Specimen Type (extensible) |
coding | S | 1..* | Coding | |
system | S | 1..1 | uri | |
code | S | 1..1 | code | |
display | S | 0..1 | string | |
text | S | 0..1 | string | Display text |
subject | S | 1..1 | Reference(DAF-Patient) | Patient |
accessionIdentifier | S | 0..1 | Identifier | |
use | S | 1..1 | code | Fixed Value: official |
system | S | 1..1 | uri | Filler URI |
value | S | 1..1 | string | Filler Identifier |
collection | S | 0..1 | BackboneElement | |
collected[x] | S I | 1..1 | dateTime, Period | inv-2: Datetime must be at least to the day. |
bodySite | S | 0..1 | CodeableConcept | Binding: USLab Specimen Body Site (extensible) |
coding | S | 1..* | Coding | |
system | S | 1..1 | uri | |
code | S | 1..1 | code | |
display | S | 0..1 | string | |
text | S | 0..1 | string | Display text |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | US Realm DAF Specimen Resource | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 0..* | Identifier | External Identifier |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) Fixed Value: official |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | Placer URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | Placer Identifier Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?! ∑ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
type | S ∑ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: USLab Specimen Type (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
parent | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |
subject | S ∑ | 1..1 | Reference(DAF-Patient) | Patient |
accessionIdentifier | S ∑ | 0..1 | Identifier | Identifier assigned by the lab |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) Fixed Value: official |
type | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | Filler URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | Filler Identifier Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
receivedTime | ∑ | 0..1 | dateTime | The time when specimen was received for processing |
collection | S | 0..1 | BackboneElement | Collection details |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
collector | ∑ | 0..1 | Reference(Practitioner) | Who collected the specimen |
comment | 0..* | string | Collector comments | |
collected[x] | S ∑I | 1..1 | dateTime, Period | Collection time inv-2: Datetime must be at least to the day. |
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: SpecimenCollectionMethod (example) | |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: USLab Specimen Body Site (extensible) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S ∑ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑ | 1..1 | uri | Identity of the terminology system |
version | ∑ | 0..1 | string | Version of the system - if relevant |
code | S ∑ | 1..1 | code | Symbol in syntax defined by the system |
display | S ∑ | 0..1 | string | Representation defined by the system |
userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user |
text | S ∑ | 0..1 | string | Display text |
treatment | 0..* | BackboneElement | Treatment and processing step details | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Textual description of procedure | |
procedure | 0..1 | CodeableConcept | Indicates the treatment or processing step applied to the specimen Binding: SpecimenTreatmentProcedure (example) | |
additive | 0..* | Reference(Substance) | Material used in the processing step | |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Binding: v2 Additive/Preservative (example) | |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Specimen.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Specimen.identifier.use | IdentifierUse | required | IdentifierUse |
Specimen.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Specimen.status | SpecimenStatus | required | SpecimenStatus |
Specimen.type | USLab Specimen Type | extensible | USLab Specimen Type |
Specimen.accessionIdentifier.use | IdentifierUse | required | IdentifierUse |
Specimen.accessionIdentifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Specimen.collection.method | SpecimenCollectionMethod | example | SpecimenCollectionMethod |
Specimen.collection.bodySite | USLab Specimen Body Site | extensible | USLab Specimen Body Site |
Specimen.treatment.procedure | SpecimenTreatmentProcedure | example | SpecimenTreatmentProcedure |
Specimen.container.type | SpecimenContainer | example | SpecimenContainer |
Specimen.container.additive[x] | v2 Additive/Preservative | example | v2 Additive/Preservative |
Id | Path | Details | Requirements |
inv-2 | Specimen.collection.collected[x] | Datetime must be at least to the day. XPath: f:matches(.,/\d{4}-[01]\d-[0-3])/) |